Android Scanbot SDK

8.0.0

Android Scanbot SDK/io.scanbot.sdk.genericdocument

Package-level declarations

Types

CommonFieldType

enum CommonFieldType : Enum<CommonFieldType>

Common field types.

DocumentProperties

data class DocumentProperties(val defaultDisplayText: String) : Parcelable

Document metadata container

data class Field(val type: FieldType, val value: OcrResult?, val confidenceWeight: Double = 1.0, val image: ImageRef? = null, val polygonInRoot: List<PointF>, val validationStatus: FieldValidationStatus = FieldValidationStatus.NONE, val parsedData: List<FieldParsedData> = listOf( )) : AutoCloseable, Parcelable

Generic document field.

FieldDataFormat

enum FieldDataFormat : Enum<FieldDataFormat>

Type of parsing applied to field.

FieldParsedData

data class FieldParsedData(val type: FieldDataFormat, val value: String) : Parcelable

Parsed data.

FieldProperties

data class FieldProperties(val defaultDisplayText: String, val defaultDisplayState: FieldProperties.DisplayState) : Parcelable

Field metadata container.

data class FieldType(val name: String, val fullName: String, val normalizedName: String, val commonType: CommonFieldType?, val listIndex: Int? = null) : Parcelable

Generic Document Type.

FieldValidationStatus

enum FieldValidationStatus : Enum<FieldValidationStatus>

Field validation status.

open class FieldWrapper(field: Field)

Non-text field wrapper

GenericDocument

data class GenericDocument(val type: GenericDocumentType, val fields: List<Field>, val children: List<GenericDocument>, val quad: List<PointF>, val quadInRoot: List<PointF>, val crop: ImageRef? = null, val confidence: Double = 0.0, val confidenceWeight: Double = 0.0) : AutoCloseable, Parcelable

Generic document.

GenericDocumentType

data class GenericDocumentType(val name: String, val fullName: String, val normalizedName: String, val listIndex: Int? = null) : Parcelable

Generic Document Type.

GenericDocumentWrapper

open class GenericDocumentWrapper(val document: GenericDocument)

Base class for strongly-typed GenericDocument wrappers

data class OcrResult(val text: String, val confidence: Double) : Parcelable

Result of OCR text recognition.

TextFieldWrapper

open class TextFieldWrapper(field: Field) : FieldWrapper

Text field wrapper

Functions

childByDocumentType

fun GenericDocument.childByDocumentType(name: String): GenericDocument?

Returns a sub-document given its document type name. Returns null if not found.

childrenByDocumentType

fun GenericDocument.childrenByDocumentType(name: String): List<GenericDocument>

Returns all children given their document type name.

fieldByTypeName

fun GenericDocument.fieldByTypeName(name: String): Field?

Returns a field given its local or common type name. Returns null if not found.

fieldsByTypeName

fun GenericDocument.fieldsByTypeName(name: String): List<Field>

Returns all fields given a local or common field type name.